PUBLIC SERVICES [PROD]
    PUBLIC SERVICES [PROD]
    • Introduction
    • Document Management
    • External Integration
    • Authentication
      • Generate a token to access ROIT APIs
        POST
    • Invoice-to-Pay
      • Documents Manager
        • Create document export request
        • Get export request by id
        • Delete export request by id
        • Generate signed URLs for export files by id
      • External System Integration
        • Register delivery integration
        • Get pending entities to be integrated
        • Update integration status
        • Get all documents attached to a request
        • Reprocess a specific request
      • Upload Document
        • Upload document as base64
    • Tax Reform
      • Data Integration
        • Create a new request
        • Update request status
        • List requests
        • Get request by ID
        • List Requests
        • Update request by ID
        • Delete request by ID
        • Generate signed URL
        • Process callback

    Introduction

    ROIT Public APIs#

    Welcome to the Invoice-To-Pay portal! This guide will help you integrate ROIT's public APIs with your system quickly and efficiently.

    Available Environments#

    We currently offer two environments for interacting with our APIs:
    1.
    Homologation (hom): A staging environment used for validation before moving to production.
    2.
    Production (app): The live environment accessed by end users.
    Base URL:
    https://<env>.roit.ai
    To use the APIs, replace <env> with the corresponding environment identifier (hom or app).
    Example:
    https://app.roit.ai/service/api/v1/document/status

    Authentication#

    Generate token#

    All our endpoints are authenticated using a JWT (JSON Web Token Authentication) token, which is valid for 8 hours after its generation.
    To generate a token, you can use the following endpoint, you will need to provide your apiToken available at ROIT ADMIN section:
    Access the authentication request documentation here
    Modified at 2025-03-31 12:42:21
    Next
    Document Management
    Built with