Referência da API

A referência abaixo carrega o Swagger oficial da Agilize. Se o arquivo remoto estiver indisponível, o portal usa a última versão local versionada no projeto.

Ela segue o padrão esperado para documentação técnica: busca por endpoints, detalhes de parâmetros e respostas, botão de teste de requisição, download do documento OpenAPI e geração de código básico por linguagem.

Base da API

https://api.agilize.app

As chamadas autenticadas usam a chave de API no cabeçalho:

Accept: application/json
x-api-key: SUA_CHAVE_API

Exemplos rápidos

Os exemplos abaixo usam a listagem de oportunidades como ponto de partida. Para outros recursos, selecione o endpoint correspondente na referência interativa e use o gerador de código do Scalar.

curl --request GET 'https://api.agilize.app/crm/lead/lead' \
  --header 'Accept: application/json' \
  --header 'x-api-key: SUA_CHAVE_API'

const response = await fetch('https://api.agilize.app/crm/lead/lead', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'x-api-key': 'SUA_CHAVE_API'
  }
})
const data = await response.json()

import requests
response = requests.get(
    'https://api.agilize.app/crm/lead/lead',
    headers={
        'Accept': 'application/json',
        'x-api-key': 'SUA_CHAVE_API',
    },
)
data = response.json()

<?php
$curl = curl_init('https://api.agilize.app/crm/lead/lead');
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'x-api-key: SUA_CHAVE_API',
    ],
]);
$response = curl_exec($curl);
curl_close($curl);

Testar e gerar código

Na referência interativa, abra um endpoint, use a área de teste para preencher parâmetros e autenticação, e alternar entre clientes HTTP para gerar exemplos em cURL, JavaScript, Node.js, Python, PHP, Go, Java, C#, Ruby, Swift e outras linguagens suportadas.