{ "item": [ { "id": "bfb48193-a57b-49b6-b208-f6cb59c1dab1", "name": "Campaigns", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0ecd131c-1c4e-4b56-a1b9-0f2d5442f9f9", "name": "Lists campaigns", "request": { "name": "Lists campaigns", "description": {}, "url": { "path": [ "api", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c41dbf6b-7ed1-409e-b8a3-b06c764d3d30", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"abc123\",\n \"type\": \"campaigns\",\n \"attributes\": {\n \"title\": \"My Cool Campaign\",\n \"launch_date\": \"2021-01-01T18:35:53.371Z\",\n \"active_iteration\": \"ajH\"\n }\n },\n {\n \"id\": \"def567\",\n \"type\": \"campaigns\",\n \"attributes\": {\n \"title\": \"My Cool Campaign\",\n \"launch_date\": \"2021-01-01T18:35:53.371Z\",\n \"active_iteration\": \"K6n\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b29fce-2d3b-4598-9a78-f2c0def3ed47", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52b4ceba-1a67-4e0e-8674-51fa14491542", "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c398ad39-8adc-46a8-a814-a28cda4a3cd3", "name": "Retrieves a Campaign", "request": { "name": "Retrieves a Campaign", "description": {}, "url": { "path": [ "api", "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b7027d9a-a45a-4722-8048-7901fa53a0cd", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"def567\",\n \"type\": \"campaigns\",\n \"attributes\": {\n \"title\": \"My Cool Campaign\",\n \"launch_date\": \"2021-01-01T18:35:53.371Z\",\n \"active_iteration\": \"K6n\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8fb9c87-cd24-454f-84dd-0190d7f9e015", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "487ebf8e-0ee5-44c9-891f-ec50392b735c", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api2.jebbit.com/", "key": "baseUrl" } ], "info": { "_postman_id": "7d576a66-8453-4ab9-89d2-7aad2651b44c", "name": "Jebbit Auth Campaigns API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Introduction\nUse our Jebbit API to automate tasks relating to your Jebbit Businesses, Campaigns, Product Feed, Launch Links, and Integrations.\n# Authentication Guide\nUse the `client_id` and `client_secret` provided by Jebbit in the [Auth Endpoint](/#tag/Auth) to generate an `access_token`. This token is valid for 24 hours. After that you'll need to hit the endpoint again to generate a new token.\n## Making API Requests\nJebbit requires your `access_token` (which is a [Json Web Token](https://jwt.io/) / JWT) to be included in all API requests. It must be sent in the `Authorization` header in the following format:\n\n`Authorization: Bearer `\n\n**Important:** If your `access_token` has permissions (scopes) to multiple businesses, then we require you to send an `x-jebbit-business` header with every request. The value of this header is a business' ID. This header sets the scope of the request to the business provided.\n## API Resource Sorting\nAll resources from the API are listed descending by the time they were created.\n# Integration/Webhook Client Guide\nWhen using our [Integrations endpoint](/#tag/Integrations) to receive Jebbit webhooks there are a few key things you want to keep top-of-mind. To help assist in this process, we've created an [Example Webhook Client Repo](https://github.com/jebbit/jebbit-webhook-client-example) as a kickstarter.\n## Test Webhooks\nYou're able to [send a test webhook](/#tag/Integrations/) to your endpoint to verify that your integration and endpoint are properly set up. Test Webhooks allow you to test out the signature verification process before activating your Integration.\n\n**Important:** Jebbit sends an `x-jebbit-test` header with every test webhook. You should ensure there is logic in your application to properly discard these webhooks and not continue processing them through your data ingestion process.\n## Jebbit Webhooks\nAll webhooks Jebbit sends contain an `x-jebbit-signature` header. This header is how you can verify that the request to your endpoint is from Jebbit.\n## Anatomy of a Jebbit Signature\nThe value of a Jebbit Signature will be a string with two key/value pairs separated by a comma. The first part is the unix timestamp of when the webhook was sent and the second part is the hmac of the payload it carries.\n`x-jebbit-signature: t=#{timestamp},v1=#{hmac}`\n## Verifying a Signature\nThe first step of validating a signature is ensuring that the timestamp provided is within a reasonable threshold from the current timestamp, say 5 minutes. If a webhook is outside of this threshold it is recommended to not process it any further -- this helps guard against replay attacks.\n\n\n```ruby\n# Example in Ruby\nif timestamp < Time.now.to_i - 300 # 300 seconds = 5 minutes\n raise StandardError, 'Timestamp outside of tolerance'\nend\n```\n\nThe next step will be to verify the `hmac` passed along by the `v1` attribute of the signature. To verify this you'll need to do the following:\n\n```ruby\n# Example in Ruby/Rails\n# Step 1 - regenerate the payload by using the timestamp the header\ngenerated_payload = \"#{timestamp}.#{request.body}\"\n\n# Step 2 - create an HMAC of the generated_payload using the `shared_secret` for the integration\n\ncalculated_hmac = Base64.strict_encode64(\n OpenSSL::HMAC.digest('sha256', shared_secret, generated_payload)\n)\n\n# Step 3 - securely verify that the two hmacs are equal\nActiveSupport::SecurityUtils.secure_compare(hmac, calculated_hmac)\n\n# if they are equal, then you can accept the payload as valid & continue processing.\n```\n", "type": "text/plain" } } }