Introdução à API

A Merx oferece uma interface de programação web baseada no modelo REST, permitindo interagir com o sistema da MerX de várias maneiras. Isso inclui a execução de comandos, a verificação de configurações e a sincronização com seus sistemas.

A comunicação com a API é estabelecida através do endereço base: api.merx.tech, sempre precedido pelo protocolo seguro https://. As diferentes versões da API são organizadas em diretórios específicos e são acessíveis através de URLs como (https://api.merx.tech/api/v1). Para saber como acessar o ambiente de homologação clique aqui!

Endereço para comunicação com a API

Este documento trata da versão da API 1.0.

O endereço para se comunicar através desta versão é: https://api.merx.tech/api/v1

Exemplos da utilização prática das chamadas de nossa API podem ser conferidas na seção de conceitos técnicos, também disponibilizamos uma collection no Postman com modelos de requisição. https://api.postman.com/collections/26533536-1cebf783-cdfe-4f21-affe-7cf05e4643ec?access_key=PMAT-01KMDTPNW2PRFZTWNHRRJT7ZTA

Configurando a collection do Postman

Após importar a collection, preencha as duas variáveis abaixo:

Variável	Valor
base_url	Produção: https://api.merx.tech — Homologação: https://homolog.api.merx.tech
api_key	Sua chave de API, enviada no header Authorization

Atenção ao preencher

• O base_url não inclui /api/v1: os caminhos das requisições já começam com /api/v1/integration/....
• A chave vai no header Authorization crua, sem o prefixo Bearer. Veja Autenticação.

Identificadores usados nos caminhos (por exemplo {{producer_id}}) devem ser preenchidos com valores do seu ambiente. As requisições que exigem parâmetros de consulta já vêm com valores de exemplo, que podem ser substituídos.

Limite de requisições

Cada chave de API pode realizar até 60 requisições por minuto. Ao exceder o limite, a API responde com 429 Too Many Requests (API rate limit exceeded).