Introdução

Introdução

A documentação foi concebida em forma de "jornada do cliente" para auxiliar na integração com as API's da Zoop, sendo ela divida em 4 principais tópicos:

  • Cadastro e credenciamento
    Esse tópico é o ponto de partida e nele abordamos desde credenciamento, ou seja, o cadastro dos vendedores, compradores, envio de documentos, passando por dados bancários até associação de planos de vendas.

  • Gestão de transação e recebíveis
    Aqui onde começam as movimentações financeiras no marketplace. Nesse momento é possível criar token de cartão, transações de cartão não presente (online), pagamentos recorrentes (planos e assinaturas), mundo físico, boleto bancário e Split de transação.

  • Repasses e transferências
    Nesse momento o marketplace e os sellers tem a possibilidade de receber os valores transacionados.

  • Notificações e eventos
    Será possível receber eventos de webhooks com as informações de acordo com as requisições (request) realizadas assim como: Criação de vendedor, transações com sucesso, transações falhadas e etc.

Para mais detalhes sobre nossos produtos, acesse o nosso "Guia de Implementação".

Aspectos técnicos

A API Zoop está implementada em conformidade com o princípio de design REST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, PUT, GET, DELETE, para operações de leitura e escrita, bem como o modelo básico de autenticação HTTP.

Nós suportamos chamadas diretas aos recursos da API a partir de outras origens, CORS (cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web. Todas as respostas da API estão no formato de dados JSON, incluindo errors.

Para permitir que você possa explorar todos os serviços sem preocupação, utilize nossas credenciais que são compostas de marktplace_id, seller_id e publishable_key (ZPK) de acesso, nos modos de produção (LIVE) e teste (TEST). Não é possível alternar entre modos, basta usar a credencial apropriada para realizar operações em produção ou ambiente de teste. Lembrando que, chamadas realizadas com credenciais de teste, não são processadas junto a instituições bancárias.