Cadastrar Companhia Produtora
Descrição: Cria uma nova Companhia Produtora.
Endpoint
POST/api/v1/integration/producers
Regras
| Atributos | Descrição | Tipo | Obrigatório | Validações |
|---|---|---|---|---|
| company_name | Razão social | String | Não | Até 255 caracteres. No caso de pessoa física, este campo não será considerado. |
| trading_name | Nome fantasia | String | Sim | Até 100 caracteres. Obs: no caso de pessoa física informar o nome. |
| social_identity | CPF no caso de PF / CNPJ no caso de PJ | String | Sim | Aceita apenas números / Não permite que tenha outra Companhia Produtora com o mesmo CPF ou CNPJ |
| E-mail de contato | String | Não | Formatação de e-mail com @ e provedor | |
| date_of_birth | Data de nascimento | Date | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. |
| rg | RG | String | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. |
| marital_status | Estado Civil | Enum | Não | Este campo somente será considerado caso o campo social_identity informado seja um CPF. Enumerador(NOT_MARRIED, MARRIED, SEPARATE, DIVORCED, WIDOWER) |
| dap_code | Registro DAP | String | Não | Até 30 caracteres. |
| caf_code | Registro CAF | String | Não | Até 30 caracteres. |
| ricaf_code | Registro RICAF | String | Não | Até 30 caracteres. |
Exemplo de Requisição
- cURL
- Java
- JavaScript
- Python
curl -X POST \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"trading_name": "Agro Exemplo Ltda",
"social_identity": "12345678000190"
}' \
"https://api.merx.tech/api/v1/integration/producers"
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String body = "{\"trading_name\": \"Agro Exemplo Ltda\", \"social_identity\": \"12345678000190\"}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.merx.tech/api/v1/integration/producers"))
.header("Authorization", "{SUA_API_KEY}")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(body))
.build();
HttpClient client = HttpClient.newHttpClient();
try {
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
const response = await fetch(
'https://api.merx.tech/api/v1/integration/producers',
{
method: 'POST',
headers: {
'Authorization': '{SUA_API_KEY}',
'Content-Type': 'application/json',
},
body: JSON.stringify({
trading_name: 'Agro Exemplo Ltda',
social_identity: '12345678000190',
}),
}
);
const data = await response.json();
console.log(data);
import requests
url = "https://api.merx.tech/api/v1/integration/producers"
headers = {
"Authorization": "{SUA_API_KEY}",
"Content-Type": "application/json"
}
payload = {
"trading_name": "Agro Exemplo Ltda",
"social_identity": "12345678000190"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
Parâmetros
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Chave de API obtida via support-api@merx.tech | String | Sim |
| Content-Type | application/json | String | Sim |
Parâmetros do Corpo
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| company_name | Razão social | String | Não |
| trading_name | Nome fantasia | String | Sim |
| social_identity | CPF no caso de PF / CNPJ no caso de PJ | String | Sim |
| E-mail de contato | String | Não | |
| date_of_birth | Data de nascimento | Date | Não |
| rg | RG | String | Não |
| marital_status | Estado Civil | Enum | Não |
| dap_code | Registro DAP | String | Não |
| caf_code | Registro CAF | String | Não |
| ricaf_code | Registro RICAF | String | Não |
Respostas
- 200 - OK
{
"id": "string"
}
- 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
401 - Unauthorized
404 - NotFound