Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Para criar o cliente, temos que seguir o mínimo de requisitos obrigatórios, igual tem no sistema. Por isso verifique quais são os requisitos no seu sistema :)
Vamos criar a seguinte requisição, por meio do método abaixo:
{
"codigo_cliente_integracao": "CodigoAPI/XXXX1",
"email": "testeAPIxxxx1@gmail.com",
"razao_social": "Cliente da API/XXXX1",
"nome_fantasia": "Cliente API/XXXX1",
"cnpj_cpf": "16.476.428/0001-45",
"telefone1_ddd": "011",
"telefone1_numero": "2737-2737",
"endereco": "Rua Teste de API",
"endereco_numero": "XXXX1",
"bairro": "Jardim das Integrações",
"estado": "SP",
"tags": {
"tag": "Cliente"
}
"cidade": "ADAMANTINA (SP)"
}
Observe que usei outros requisitos que não estão na API por padrão, que podem ser consultadas por aqui:
📌 Um ponto importante é que a cidade, não foi informada por meio de um nome, e sim por um código. E esse código pode ser obtido aqui:
Obs.: O código da cidade que precisamos, é o "cCod"; |
Quando executamos a nossa requisição, temos o seguinte resultado:
Observe que ele tornou com sucesso a seguinte mensagem:
{
"codigo_cliente_omie": 5366578425,
"codigo_cliente_integracao": "CodigoAPI/XXXX1",
"codigo_status": "0",
"descricao_status": "Cliente cadastrado com sucesso!"
}Essa tag retornada “codigo_cliente_omie” é muito importante, pois, é com ela que vamos consultar e fazer operações com nosso cliente via API
E aqui está nosso cliente no sistema:
📌 Separamos alguns artigos interessantes para você
