PORTAL DE DOCUMENTAÇÃO
Gestão Agro
Gestão Agro — Manual do Usuário > Hub de Royalties > APIs de Integração do Hub de Royalties

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

ClosedRegistrar entrega

endpoint: deliveryRegister

/royalties_hub/actions/deliveryRegister

ClosedExemplo POST
ClosedInput 
{
  "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"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "statusCode": 0,
      "message": "string",
      "deliveryId": "string",
      "integrationId": "string"
    }
  ]
}
ClosedRegistrar fixação

endpoint: fixationRegister

/royalties_hub/actions/fixationRegister

ClosedExemplo POST
ClosedInput 
{
  "fixationRegisterList": [
    {
      "matrixDocNumber": "string",
      "matrixOfficeName": "string",
      "affiliateDocNumber": "string",
      "affiliateName": "string",
      "growerDocNumber": "string",
      "growerName": "string",
      "fixNumber": "string",
      "quantity": 0,
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "statusCode": 0,
      "message": "string",
      "id": "string",
      "integrationId": "string"
    }
  ]
}
ClosedCancelamento de entrega

endpoint:deliveryCancel

/royalties_hub/actions/deliveryCancel

ClosedExemplo POST
ClosedInput 
{
  "deliveryCancelList": [
    {
      "deliveryId": "string",
      "deliveryDate": "2025-06-25",
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "statusCode": 0,
      "message": "string",
      "deliveryId": "string",
      "integrationId": "string"
    }
  ]
}
ClosedConsultar status da entrega

endpoint:checkStatus

/royalties_hub/actions/checkStatus

ClosedExemplo POST
ClosedInput 
{
  "checkStatusList": [
    {
      "deliveryId": "string",
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "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"
        ]
      }
    }
  ]
}
ClosedConsultar status da fixação de royalties

endpoint: checkStatusFixRoyalties

/royalties_hub/actions/checkStatusFixRoyalties

ClosedExemplo POST
ClosedInput 
{
  "checkStatusList": [
    {
      "id": "string",
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "statusCode": 0,
      "message": "string",
      "id": "string",
      "integrationId": "string",
      "result": {
        "status": "REGISTERED",
        "quantityFixed": 0,
        "integrationId": "string"
      }
    }
  ]
}
ClosedConsultar pendências de créditos do produtor

endpoint: checkCreditProducers

/royalties_hub/actions/checkCreditProducers

ClosedExemplo POST
ClosedInput 
{
  "producers": [
    {
      "matrixDocNumber": "string",
      "affiliateDocNumber": "string",
      "growerDocNumber": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "matrixDocNumber": "string",
      "affiliateDocNumber": "string",
      "growerDocNumber": "string",
      "qtdPending": 0,
      "qtdAvailable": 0
    }
  ]
}
ClosedConsumir créditos dos produtores

endpoint: consumeCreditProducers

/royalties_hub/actions/consumeCreditProducers

ClosedExemplo POST
ClosedInput 
{
  "consumeCreditProducersList": [
    {
      "matrixDocNumber": "string",
      "affiliateDocNumber": "string",
      "growerDocNumber": "string",
      "qtdConsume": 0,
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "status": 0,
      "message": "string",
      "integrationId": "string",
      "transactionId": "string",
      "consumptionId": "string"
    }
  ]
}
ClosedConsultar créditos consumidos da lista de pendências

endpoint: checkStatusConsumeCreditProducers

/royalties_hub/actions/checkStatusConsumeCreditProducers

ClosedExemplo POST
ClosedInput 
{
  "consumeCreditProducersList": [
    {
      "integrationId": "string"
    }
  ]
}
ClosedResponse 
{
  "data": [
    {
      "statusCode": 0,
      "message": "string",
      "integrationId": "string",
      "quantityConsumed": 0,
      "quantityPending": 0
    }
  ]
}
ClosedGerenciar compra imediata

endpoint: immediateBuyRegister

ClosedExemplo POST
Closedinput 
{
  "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"
  }
}
Closedresponse 
{
  "data": {
    "statusCode": 200,
    "message": "",
    "deliveryId": "e16c0847-a6e5-4d1e-8adc-a5ef49930552",
    "integrationId": "INTEGRATION-4"
  }
}
ClosedConferir compra imediata

endpoint: checkImmediateBuy

ClosedExemplo POST
Closedinput 
{
  "checkStatus": {
    "deliveryId": "085b14d9-f13c-490c-90aa-602a1224e51c",
    "integrationId": "INTEGRATION-2"
  }
}
Closedresponse 
{
  "data": {
    "statusCode": 200,
    "message": "ERROR",
    "deliveryId": "085b14d9-f13c-490c-90aa-602a1224e51c",
    "integrationId": "INTEGRATION-2",
    "result": {
      "status": "ERROR",
      "quantityCargo": 200.0,
      "quantityPending": 200.0
    }
  }
}

Conheça o Hub de Royalties

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Contrato de Licenciamento de Software e Prestação de Serviços

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo