How to Use Pramata API Portal

Prerequisites

Before accessing the API Portal, ensure you have:

• Access to a Pramata UAT or PROD instance
• Relevant Pramata APIs enabled for your account
• Valid login credentials for the API Portal

Accessing the API Portal

1. Navigate to the appropriate environment:
   
   • UAT: https://api-portal-uat.pramata.com/
   • PROD: https://api-portal.pramata.com/
     
2. Enter your login credentials.
3. Select your organization from the available options.
   

Setting Up API Access

Obtaining API Credentials

1. Click client credentials.
   
2. Copy and securely store your API Key & Shared Secret
   Note: These credentials cannot be retrieved later, so store them safely.
   

Generating an Access Token

1. Click Authorize in the top right corner.
2. Enter your client_id & client_secret (from the previous step)
3. Click the Authorize button, then Close button.
   

Testing the API

Submitting Documents

1. Click POST from the available operations.
2. Click Try it out to enable the request form.
3. Click Choose File and select the file you wish to upload.
4. Enter a valid username in uploader field.
5. Set the is_base64_encoded parameter to false in the dropdown menu.
6. Click Add item and enter the required JSON metadata in terms field.
7. Click Execute to submit your request.
   

Reviewing API Response

• The server response will appear on the right side of the page.
  
  
  
• Sample code snippets are available for reference and implementation in your applications.