Introdução

O que é a API de CRM

CRM API — API HTTP com respostas no formato JSON. Através dele, um sistema externo trabalha com os mesmos dados que o CRM FoodSoul: lê, cria e altera-os em nome da conta.

Todas as solicitações são enviadas via HTTPS para o endereço https://foodsoul.ru/api/crm/v2.

O guia da API descreve cada método: parâmetros, corpo da requisição, respostas e exemplos em curl, PHP, JavaScript e Python. A descrição completa da API pode ser baixada no formato OpenAPI e conectada ao Postman, Insomnia ou a um gerador de SDK.

Como obter um token de API

As solicitações de integração são autorizadas por meio de um token de API. O token é emitido pelo proprietário ou administrador da conta no CRM, na seção "Tokens de API".

1. Abra a seção "Tokens de API" no CRM e crie um token.
2. Selecione o papel do token: os métodos disponíveis dependerão dele. O papel do token emitido não pode ser alterado.
3. Para que o token funcione apenas com uma rede, selecione-a. Sem a seleção de uma rede, o token terá acesso a todas as redes da conta e as requisições transmitirão a rede no cabeçalho chain.
4. Se necessário, defina o prazo de validade do token e os endereços IP permitidos.
5. Copie o token imediatamente após a criação: o valor exibido é mostrado apenas uma vez e não pode ser recuperado.

O token começa com fs_api_ e é transmitido no cabeçalho Authorization: Bearer <token>. O token deve ser armazenado como uma senha: não o publique no código de sites ou aplicativos móveis e não o compartilhe com terceiros. Caso o token seja perdido, bloqueie-o ou exclua-o na mesma seção do CRM.

Primeira solicitação

Verifique o token com a solicitação «Obter dados do usuário». Em vez de fs_api_YOUR_TOKEN, insira o seu próprio token.

Além do token, cada requisição envia os cabeçalhos role — função, para esta API partner, e language — idioma dos textos na resposta, por exemplo pt.

curl -X GET 'https://foodsoul.ru/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/application.user_info', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/application.user_info", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/application.user_info",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
)
data = response.json()

Resposta bem-sucedida — HTTP 200 e JSON com status: success, os dados estão no campo data. Em caso de erro, status é igual a error, e o código e a mensagem de erro estão no campo error.

Descrição do método: Obter dados do usuário →

O que fazer a seguir

• Referência da API — todos os métodos com parâmetros, respostas e exemplos de solicitações
• Autorização — títulos de autorização e conjuntos que aceitam métodos
• Webhooks — notificações de eventos para o endereço do seu sistema
• Erros — códigos de erro e seus significados
• Alterações — o que mudou na API
• Baixar OpenAPI · YAML