Gagnez avec nous

{
  "openapi": "3.0.3",
  "info": {
    "title": "MarineHelper Partner API",
    "version": "2.0.0",
    "description": "Endpoints available to a partner account. Ordering endpoints accept an x-api-key header. Balance and payout endpoints under /rewards require a signed-in session plus x-csrf-token and reject API keys with 403."
  },
  "servers": [
    {
      "url": "https://fastify.app.x.marinehelper.com/api/v1",
      "description": "Production"
    }
  ],
  "paths": {
    "/user/partner/register": {
      "post": {
        "summary": "Register a business partner account.",
        "security": []
      }
    },
    "/user/balance/mailing-order-info": {
      "post": {
        "summary": "Price a mailing order with the partner reward applied.",
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/user/file/mailingorder": {
      "post": {
        "summary": "Place a mailing order under the partner account.",
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/user/orders": {
      "get": {
        "summary": "List orders placed under the partner account.",
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/mailing/seaman/seaman-mailing/{id}/pdf-link": {
      "get": {
        "summary": "Get the branded PDF report link for a mailing.",
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/user/partner/rewards/balance": {
      "get": {
        "summary": "Read the reward balance, turnover, both tier rates and the hold. Session only, 403 for API keys.",
        "security": [
          {
            "session": []
          }
        ]
      }
    },
    "/user/partner/rewards/payouts": {
      "get": {
        "summary": "List payout requests. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      },
      "post": {
        "summary": "Request a USDT payout. Session only, 403 for API keys.",
        "security": [
          {
            "session": []
          }
        ]
      }
    },
    "/affiliate/me": {
      "get": {
        "summary": "Blogger profile, referral link and click stats. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      }
    },
    "/user/referral-program/summary": {
      "get": {
        "summary": "Seafarer referral cabinet in one call. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      }
    },
    "/company/api-keys": {
      "get": {
        "summary": "List API keys. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      },
      "post": {
        "summary": "Create an API key. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      }
    },
    "/user/partner/settings": {
      "patch": {
        "summary": "Update white-label branding settings. Session only.",
        "security": [
          {
            "session": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      },
      "session": {
        "type": "apiKey",
        "in": "header",
        "name": "x-csrf-token",
        "description": "Requires a signed-in session cookie plus this header."
      }
    }
  }
}