Skip to main content

Getting Started

This page helps you start integrating with the Trademark Engine API. It explains the tasks you must perform to start building an integration. To get started and make Trademark Engine API calls, you have five tasks:

  1. Plan your integration
  2. Read documentation and request sandbox API key
  3. Set up authentication
  4. Test your first API calls
  5. Implement Customer Portal Integration API for real-time updates

You can also use these pages to help you get started integrating with the Trademark Engine API:

Task 1: Plan Your Integration​

Consider your use-case: Carefully define the purpose of your integration and decide the scope of your implementation. This helps you understand the actions that your integration (or users of your integration) will perform and gives you an idea of which Trademark Engine APIs you'll use.

Start with simple flows: We recommend starting with simple, standalone services to minimize complexity and development effort:

  • Comprehensive Search Report: A straightforward service that doesn't require complex workflows.
  • DMCA Takedown: An independent offering that integrates seamlessly into broader workflows.

Determine your integration approach: Consider the security implications and development effort involved:

  • Server-to-server integration: More secure, requires backend development
  • Client-side integration: Faster to implement but requires careful security considerations
  • Hybrid approach: Combine both for optimal security and user experience

Security considerations:

  • API keys should never be exposed in client-side code
  • Implement proper authentication and authorization
  • Consider data encryption for sensitive customer information
  • Plan for secure storage of customer data and API responses

Task 2: Read Documentation and Request Sandbox API Key​

Review the documentation: Before requesting access, thoroughly review our API documentation to understand:

  • How information flows through the API
  • Available endpoints and their capabilities
  • Authentication requirements
  • Rate limiting and usage policies
  • Data formats and required fields

Contact sales for API access: Access to the Trademark Engine API requires a signed partnership agreement. To get started:

  1. Contact our sales team at [email protected]
  2. Discuss your integration plans and expected usage volume
  3. Sign the partnership agreement which includes terms of service and pricing
  4. Receive your sandbox API credentials for development and testing

Important: Sandbox access is only provided after completing the partnership agreement process.

Task 3: Set Up Authentication​

API Key Management:

  • Securely store your API keys using environment variables or secure configuration
  • Never commit API keys to version control
  • Implement key rotation procedures for production environments. We may revoke keys periodically with a 30 day previous notice, so make sure you can replace keys easily.

Authentication Headers:

All API requests require proper authentication headers.

Task 4: Test Your First API calls​

Start with simple endpoints:

  1. Health Check: Verify your connection and authentication
  2. Service Availability: Check which services are available in your target states
  3. Pricing Information: Understand costs for different services
  4. Test Data: Use our provided test data sets to validate your integration without affecting real records or incurring charges.

Task 5: Implement Customer Portal for Real-Time Updates​

Set up Customer Portal endpoints: Configure your application to receive real-time notifications about:

  • Order status changes
  • Document completion
  • Payment processing updates
  • Filing status updates

Customer Portal Security: Implement proper Customer Portal signature verification to ensure requests are coming from Trademark Engine.

For detailed Customer Portal implementation, see our Customer Portal Integration API Documentation.

Best Practices​

  • Error Handling: Implement comprehensive error handling for all API calls
  • Rate Limiting: Respect API rate limits and implement proper backoff strategies
  • Logging: Maintain detailed logs for debugging and monitoring
  • Testing: Thoroughly test in sandbox before moving to production
  • Documentation: Keep your integration documentation up to date

Need Help?​

If you have questions or need assistance during your integration: