RefCampaignDocs

Integration self-check

Validates the secret API key and returns enough account state to confirm the integration is wired correctly: merchant name, number of active campaigns, and Stripe Connect status (connected + mode). Used by the SDK to surface a clear "your integration works" signal.

GET
/api/v1/ping

Validates the secret API key and returns enough account state to confirm the integration is wired correctly: merchant name, number of active campaigns, and Stripe Connect status (connected + mode). Used by the SDK to surface a clear "your integration works" signal.

Authorization

bearerAuth
AuthorizationBearer <token>

API key issued from the merchant dashboard (prefix rc_live_ / rc_test_). Sent as Authorization: Bearer <token>. Used by the SDK and any direct server-to-server integration.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.refcampaign.com/api/v1/ping"
Empty
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}