API

Otorisasi

Setiap permintaan ke CRM API mengirimkan header otorisasi. Header yang diperlukan untuk metode tertentu tercantum di halamannya pada bagian "Otorisasi".

Integrasi diotorisasi dengan API-token di header Authorization. Token akses token-access diberikan saat login melalui API dan cocok untuk aplikasi yang bekerja atas nama pengguna.

Judul

api-token

Judul: Authorization · Format: fs_api_* · Digunakan dalam metode: 365

Token API dari bagian api_tokens. Nilai header Authorization adalah Bearer <token>. Token mitra: jika jaringan dipilih saat penerbitan token, token hanya berlaku untuk jaringan tersebut dan header chain tidak diperlukan. Jika jaringan tidak dipilih, token memiliki akses ke semua jaringan dalam akun, tetapi tidak memiliki jaringan aktif. Setiap permintaan yang memerlukan jaringan harus menyertakan header chain, jika tidak akan mengembalikan error 117 dengan field: chain. /chains mengembalikan daftar jaringan akun; /chains.switch tidak tersedia untuk token ini (error 268).

Contoh

Authorization: Bearer fs_api_YOUR_TOKEN

language

Judul: language · Digunakan dalam metode: 374

Bahasa respons — kode ISO 639-1, misalnya ru

Contoh

language: id

role

Judul: role · Digunakan dalam metode: 374

Peran pengguna: partner atau affiliate

Contoh

role: partner

chain

Judul: chain · Digunakan dalam metode: 0

Jaringan tempat permintaan dijalankan. Wajib hanya untuk token mitra yang diterbitkan tanpa pemilihan jaringan; dalam kasus lain diabaikan

Contoh

chain: YOUR_TOKEN

Set judul

Metode ini menerima salah satu set. Set dengan API-token cocok untuk integrasi.

api-token + language + rolemetode: 365
language + rolemetode: 9

Kesalahan akses

Token yang tidak valid, diblokir, atau kedaluwarsa serta permintaan tanpa header yang diperlukan akan mengembalikan kesalahan dengan kode. Nilai kode dapat ditemukan di bagian "Kesalahan".

Kesalahan →