Considerações Gerais

🛠️ Codificação

Todas as requisições GET, POST, PUT, PATCH e DELETE são codificadas em JSON com charset UTF-8 e devem ter o Content-Type definido como application/json:

<?php
$ch = curl_init('https://api.tickler.com.br/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer sk_XXXXXXXX",
    "Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);

echo $response;

🌐 Métodos HTTP

Nós utilizamos os métodos HTTP padrão para indicar a intenção da requisição sobre um determinado recurso:

  • GET - Consultar um recurso específicou ou uma coleção de recursos

  • POST - Criar um novo recurso

  • PUT / PATCH - Atualizar um recurso ou executar uma ação associada a um recurso

  • DELETE - Remover um recurso

🔒 Autenticação

🔐 A autenticação é feita via Bearer Token.

Você pode aprender mais sobre como autenticar na API acessando o tutorial abaixo:

Conectando na API

📏 Padrão de Campos

Tipo de Campo
Padrão Esperado
Exemplo

Data

Ano-Mês-Dia

2020-12-01

Data e Hora

Ano-Mês-Dia Hora:Minuto:Segundo

2020-12-01 12:00:00

Decimal

Separado por "." no decimal

1500.25

Inteiro

Número inteiro limitado a 10 caracteres

11

🕒 Horários

O sistema sempre enviará datas e horas no fuso horário GMT-3.

Atualizado