Quickstart

🚀 Quick Start Guide

Welcome to the Quick Start section of the SGA API Documentation! Let’s get your integration up and running in no time. Here, you’ll learn how to authenticate with our API using OAuth2, access our staging and production environments, and set up your app credentials.

🌐 Environments

The SGA API provides two independent environments for your development journey:

  1. Staging Environment: Base URL: https://staging.associado.sbpbrasil.org/api Use this environment for development and testing without affecting live data.

  2. Production Environment: Base URL: https://associado.sbpbrasil.org/api This is the live environment for production-ready applications.

🔑 Important: Credentials for each environment are separate. Ensure you request staging credentials for development and production credentials after your app is approved.

📝 Requesting Credentials

To access the API, you’ll need credentials. Follow these steps:

1️⃣ Send an Email to Request Credentials

Email: [email protected] Include the following information:

  • App Name: A descriptive name for your app.

  • Full Name: The full name of the person responsible for the integration.

  • Email Address: Contact email of the responsible person.

  • Phone Number: A direct phone number for follow-up.

  • Data Requirements: Specify which data your app needs to access.

  • App Goal: Briefly explain the purpose of your app and its intended use.

Once approved, you’ll receive the Client ID and Client Secret for the requested environment.

🔐 Authenticating with OAuth2

Our API uses OAuth2 for secure authentication. Here’s how to get started:

  1. Use your Client ID and Client Secret to request an access token.

  2. Include the token in the Authorization header of your API requests:

PreviousWelcomeNextHow to Authenticate

Last updated