APIs de Integração do Hub de Royalties
O Hub de Royalties possui uma série de APIs que permitem o acesso e compartilhamento de dados de maneira segura e eficiente.
APIs Senior
Confira a lista com todas as APIs Públicas disponibilizadas para a integração com o Hub de Royalties
endpoint: deliveryRegister
/royalties_hub/actions/deliveryRegister
{
"deliveryReceivedList": [
{
"headOfficeDocNumber": "string",
"headOfficeName": "string",
"affiliateDocNumber": "string",
"affiliateName": "string",
"growerDocNumber": "string",
"growerName": "string",
"productCode": "string",
"productName": "string",
"qtdDelivery": 0,
"deliveryDate": "2025-06-25",
"chargeResult": "POSITIVE",
"technology": "string",
"chargeType": "PLATE",
"chargeId": "string",
"truckType": "string",
"truckId": "string",
"integrationId": "string"
}
]
}
{
"data": [
{
"statusCode": 0,
"message": "string",
"deliveryId": "string",
"integrationId": "string"
}
]
}
endpoint: fixationRegister
/royalties_hub/actions/fixationRegister
{
"fixationRegisterList": [
{
"matrixDocNumber": "string",
"matrixOfficeName": "string",
"affiliateDocNumber": "string",
"affiliateName": "string",
"growerDocNumber": "string",
"growerName": "string",
"fixNumber": "string",
"quantity": 0,
"integrationId": "string"
}
]
}
{
"data": [
{
"statusCode": 0,
"message": "string",
"id": "string",
"integrationId": "string"
}
]
}
endpoint:checkStatus
/royalties_hub/actions/checkStatus
{
"checkStatusList": [
{
"deliveryId": "string",
"integrationId": "string"
}
]
}
{
"data": [
{
"statusCode": 0,
"message": "string",
"deliveryId": "string",
"integrationId": "string",
"result": {
"status": "REGISTERED",
"quantityRegistered": 0,
"quantityConsumed": 0,
"quantityCancelled": 0,
"quantityPending": 0,
"bid": "string",
"integrationId": "string",
"messages": [
"string"
]
}
}
]
}
endpoint: consumeCreditProducers
/royalties_hub/actions/consumeCreditProducers
{
"consumeCreditProducersList": [
{
"matrixDocNumber": "string",
"affiliateDocNumber": "string",
"growerDocNumber": "string",
"qtdConsume": 0,
"integrationId": "string"
}
]
}
{
"data": [
{
"status": 0,
"message": "string",
"integrationId": "string",
"transactionId": "string",
"consumptionId": "string"
}
]
}
endpoint: checkStatusConsumeCreditProducers
/royalties_hub/actions/checkStatusConsumeCreditProducers
endpoint: immediateBuyRegister
{
"immediateBuy": {
"headOfficeDocNumber": "56872262000109",
"headOfficeName": "Matriz",
"affiliateDocNumber": "56872262000109",
"affiliateName": "Filial",
"growerDocNumber": "11387031090",
"growerName": "Produtor",
"qtdDelivery": 200.0,
"deliveryDate": "2025-09-16",
"chargeResult": "POSITIVE",
"technology": "Teste",
"chargeType": "PLATE",
"chargeId": "CHARGE-4",
"integrationId": "INTEGRATION-4"
}
}
{
"data": {
"statusCode": 200,
"message": "",
"deliveryId": "e16c0847-a6e5-4d1e-8adc-a5ef49930552",
"integrationId": "INTEGRATION-4"
}
}
endpoint: checkImmediateBuy
{
"checkStatus": {
"deliveryId": "085b14d9-f13c-490c-90aa-602a1224e51c",
"integrationId": "INTEGRATION-2"
}
}
{
"data": {
"statusCode": 200,
"message": "ERROR",
"deliveryId": "085b14d9-f13c-490c-90aa-602a1224e51c",
"integrationId": "INTEGRATION-2",
"result": {
"status": "ERROR",
"quantityCargo": 200.0,
"quantityPending": 200.0
}
}
}
English
Español


