DPS API Developer Portal – Getting Started Guide

DPS API Developer Portal – Getting Started Guide

Hello,

Thank you for partnering with DPS! We’re excited to have you onboard.

Whether you’re integrating our Postal Mailing APIs or DPS Registry APIs, this guide will help you get started in just a few minutes.



Step 1: Access the Developer Portal

Choose the appropriate environment:

https://developers-stage.dps.io/

Use the sandbox environment to build and test your integration without affecting production.

Production

https://developers.dps.io/

Once you’ve completed testing, switch to the production portal to start using live APIs.

Info
If you already have an account, simply log in using your existing credentials. Otherwise, we’ve attached your temporary login credentials with this email.






Step 2: Sign In

Log in using:

  • The credentials attached with this email, or
  • Your existing DPS Developer account credentials.

After signing in, you’ll be taken to the Developer Portal dashboard.




Step 3: Generate or View Your API Key

From the top navigation bar, click:

Settings

The Settings page displays your personal API Key.

Your API Key authenticates every request made to the DPS API Gateway. All API calls must include this key in the x-api-key request header:

  • Authenticate API requests
  • Test endpoints using Swagger UI
  • Integrate DPS APIs into your own applications
  • Access protected endpoints


Warning
Keep this key secure and never expose it publicly.




Step 4: Explore Available APIs

From the top navigation menu, click:

API Endpoints

You’ll find two API collections available.

Postal Mailing APIs

Choose Postal Mailing if you’d like to integrate USPS mailing services directly into your application.

These APIs allow you to:

  • Send USPS mail online
  • Upload documents
  • Validate addresses
  • Track mailings
  • Estimate postage
  • Checkout mailing
  • Automate your complete mailing workflow

DPS Registry APIs

Choose DPS Registry if you’d like to register assets, artwork, collectibles, certificates, or other digital/physical items on blockchain.

Using DPS Registry, you can:

  • Register ownership records
  • Generate blockchain-backed certificates
  • Verify authenticity
  • Transfer ownership
  • Maintain public proof of ownership while keeping sensitive information securely stored on a private blockchain


Notes
If you’re unsure which API collection best fits your use case, feel free to contact our support team using the Support option available in the Developer Portal.




Step 5: Start Testing APIs

Once you’ve selected an API collection, you’ll be redirected to the interactive API documentation (Swagger).

From there you can:

  • Browse every available endpoint
  • View request and response examples
  • Read endpoint descriptions
  • Test APIs directly from your browser
  • Authorize requests using your API Key
Idea
You can also use the same API Key in your own application to begin development immediately.







NotesClick Authorize in the Swagger interface and paste your API Key. Once authorized, every API request you execute from Swagger will automatically include your authentication header.



Step 6: Follow the Integration Guides


Info
We highly recommend reviewing the Guides section before starting development.

Our guides include:

  • Authentication
  • API workflow
  • Request examples
  • Response formats
  • Best practices
  • Integration walkthroughs
  • Common implementation scenarios

Following these guides will help you integrate much more quickly and avoid common mistake






Info
Sandbox and Production environments maintain separate API Keys. Ensure you are using the API Key associated with the environment you’re testing against.



Need Help?

If you have any questions during integration, we’re here to help.

Simply click Support from the Developer Portal or contact our team directly.

We’ll be happy to assist you with:

  • API integration
  • Authentication
  • Testing
  • Troubleshooting
  • Best practices
  • Production deployment



Quick Start Checklist

☐ Log in to the Developer Portal
☐ Retrieve your API Key from Settings
☐ Choose the appropriate API collection under API Endpoints
☐ Review the integration Guides
☐ Test APIs using Swagger or your preferred API client
☐ Begin integrating with your application



Thank you again for choosing DPS. We look forward to supporting your integration and helping you build with our APIs.