SEOGEO Tools
    Documentation

    Developer Portal

    The Developer Portal provides everything you need to integrate SEOGEO Tools with your systems via the Public API.

    What It Is

    The Developer Portal includes:

    • API key management
    • Interactive API console
    • Endpoint documentation
    • Usage statistics
    • Integration examples

    Accessing the Portal

    1. Go to Settings > Developer Portal
    2. Or navigate to Developer in main navigation

      3. API Key Management

      Creating Keys

      1. Click Create API Key
      2. Enter a name (e.g., "Production App")
      3. Select scopes (permissions)
      4. Copy the key immediately (only shown once)

        5. Key Format

        Keys are prefixed to indicate type:

        • sg_live_... - Production keys
        • sg_test_... - Development keys

        Managing Keys

        ActionHow To
        View keysListed with name, created date, last used
        RotateGenerate new key, old stops working
        RevokePermanently disable key
        Edit scopesUpdate permissions

        Key Security

        • Keys are hashed in storage
        • Only shown once at creation
        • Rotate regularly (90 days recommended)
        • Use environment variables

        Try It Console

        Test API calls interactively:

        1. Go to Developer Portal > Try It
        2. Select an endpoint
        3. Fill in parameters
        4. Click Send Request
        5. View response

          6. Features

          • Pre-filled with your API key
          • Shows cURL equivalent
          • Displays headers and body
          • Response syntax highlighting
          • Copy code examples

          API Documentation

          In-portal documentation:

          • All endpoints listed
          • Request/response schemas
          • Authentication details
          • Error codes explained
          • Code examples

          Usage Statistics

          Monitor your API usage:

          • Requests per day/month
          • Breakdown by endpoint
          • Error rate tracking
          • Rate limit usage

          Rate Limits

          Limits vary by plan:

          PlanRequests/minRequests/day
          Starter10100
          Pro6010,000
          Enterprise300100,000

          Rate limit headers in responses:

          • X-RateLimit-Limit: Your limit
          • X-RateLimit-Remaining: Remaining
          • X-RateLimit-Reset: Reset time

          Best Practices

          1. Use descriptive key names: Identify purpose
          2. Limit scopes: Only request what's needed
          3. Monitor usage: Catch issues early
          4. Rotate keys: Regular security hygiene
          5. Handle errors: Implement proper error handling
    Was this page helpful?

    Last updated: 1/21/2025