Skip to content

Frequently Asked Questions

Find answers to common questions about the Sherpai Partner API.

Getting Started

How do I get access to the API?

Contact your Sherpai partner representative to get: - Firebase authentication credentials - API access permissions - Testing environment details

What authentication method does the API use?

The API uses Firebase authentication with JWT bearer tokens. You'll need to authenticate using the /auth/login endpoint to get an access token.

How long do access tokens last?

Firebase JWT tokens typically expire after 1 hour. You'll need to re-authenticate when your token expires.

API Usage

What data can I access through the API?

The API provides access to: - User profile information - Dashboard analytics and metrics - Facebook page data - Social media insights

Are there rate limits on the API?

Yes, the API implements rate limiting to ensure fair usage. See our rate limiting guide for details.

What response format does the API use?

All API responses are in JSON format with consistent error handling and status codes.

Technical Questions

What base URL should I use?

  • Production: https://partner-api.sherp.ai
  • Development: Contact support for staging environment details

How do I handle API errors?

The API returns standard HTTP status codes and JSON error responses. See our error handling guide for detailed information.

Can I test the API before integrating?

Yes! Use our Swagger UI to test endpoints interactively.

What programming languages are supported?

The API is RESTful and can be used with any programming language that supports HTTP requests. Common languages include: - JavaScript/Node.js - Python - cURL - Any language with HTTP client support

Data and Privacy

How is my data secured?

  • All API calls must use HTTPS
  • Authentication via Firebase JWT tokens
  • Data access is limited to your authorized brands/accounts
  • Regular security audits and monitoring

What data retention policies apply?

Information about data retention will be added here.

Is there a data usage agreement?

Yes, API usage is governed by the Sherpai Partner Agreement. Contact your partner representative for details.

Troubleshooting

I'm getting a 401 Unauthorized error

This usually means: - Your access token has expired (re-authenticate) - Your token is invalid or malformed - You're missing the Authorization header

My requests are timing out

Check: - Your internet connection - Whether you're hitting rate limits

Support

How do I report a bug?

Contact our support team at tech@loopsider.com with: - Description of the issue - Steps to reproduce - Request/response examples - Your user email

How do I request new features?

Send feature requests to tech@loopsider.com with: - Detailed description of the feature - Use case and business justification

Where can I find the latest API updates?

  • Check this documentation regularly

Still Have Questions?

Can't find what you're looking for? We're here to help: