Arquitetura da API

O modelo empregado na integração das APIs é simples. Para executar uma operação:

  1. Combine a base da URL do ambiente com o endpoint da operação desejada.

Ex.: https://api.cielo.com.br/order-management/v1/orders

  1. Envie a requisição para a URL utilizando o método HTTP adequado à operação.
Método HTTPDescrição
GETRetorna recursos já existentes, ex.: consulta de um pedido.
POSTCria um novo recurso, ex.: criação de um pedido.
PUTAtualiza um recurso existente, ex.: atualiza um item em um pedido.
DELETEExclui um recurso, ex.: exclui um item de um pedido.

Todas a operações requerem as credenciais de acesso Client-ID, Merchant ID e Access token, que devem ser enviadas no cabeçalho da requisição.

Cada envio de requisição irá retornar um código de Status HTTP, indicando se ela foi realizada com sucesso ou não.