Brief API

Brief is a shortened and ordered combination of numerous pieces of content or updates that are sent out on a regular basis. It provides an easy approach to condense and present numerous interesting facts in one style.

Note

If any of the mentioned endpoint is resulting in an error please refer to the Errors section.

Available Briefs

This endpoint allows you to retrieve a list of publicly available briefs and the ones that a user is entitled to receive.

Note

This API requires you to have a access token that should be obtained following Authorization Section. If not obtained please follow the Authorization section to correctly obtain one.

Warning

It is compulsory to have prefix Bearer on Authorization header.

Request

URL : /brief

Method : GET

Example

curl --location 'https://platform-test.ranenetwork.com/public-api/v1/brief' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer <access_token>'

Request Formatter

  • access_token : The token received on prior iteration from Get Access Token section

Response

{
  "data": [
    {
      "name": "Brief/Digest Name",
      "slug": "Brief/Digest Slug"
    },
    {
      "name": "Brief/Digest Name",
      "slug": "Brief/Digest Slug"
    }
  ]
}

Response Formatter

  • data : An array of objects that inlcudes name and slug of entitled and publicly available briefs

Specific Brief

This endpoint allows you to retrieve a specific brief publication detail along with content of latest published brief document

Note

This API requires you to have a access token that should be obtained following Authorization Section. If not obtained please follow the Authorization section to correctly obtain one.

Warning

It is compulsory to have prefix Bearer on Authorization header.

Request

URL : /brief/<brief_slug>

Method : GET

Example

curl --location 'https://platform-test.ranenetwork.com/v1/brief/<brief_slug>' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer <access_token>'

Request Formatter

  • access_token : The token received on prior iteration from Get Access Token section

  • brief_slug : Specific brief slug of your interest

Response

{
  "data": {
    "name": "Cyber Weekly Brief",
    "slug": "cyber-weekly-brief",
    "gid": "8-xxxx",
    "date_option": {
      "picker": [
        {
          "date": "2023-05-30",
          "gid": "8-xxxx",
          "selected":true
        },
        {
          "date": "2023-05-31",
          "gid": "8-xxxx"
        }
      ],
      "slider": [
        {
          "date": "May 01",
          "gid": "8-xxxx"
        },
        {
          "date": "May 03",
          "gid": "8-xxxx",
          "selected":true

        }
      ]
    },
    "article": [
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          },
          {
            "name": "The Guardian 2",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": true,
        "bookmarked": true,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      },
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          },
          {
            "name": "CNN",
            "link": "https://example.com"
          },
          {
            "name": "BBC",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": false,
        "bookmarked": false,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      },
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": null,
        "bookmarked": false,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      }
    ],
    "bookmarked": true,
    "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A",
    "upgrade": "https://example.com",
    "web": "https://example.com"
  },
  "error": []
}

Response Formatter

  • bookmarked : A boolean value indicating whether or not user has bookmarked certain brief/article.

  • source : An object containing name of website and original link to which article was published

  • share : A mailto link that pushes snippet to mail

  • category : Represent category to which article was labeled for specific brief

  • article : A list of object containing all the articles that were recently published on specific brief

  • date_option : An object containing all the date where specific brief was published along with document gid

  • data : An object of brief containing publication details and articles of latest brief

Specific Brief Document

This endpoint allows you to retrieve a specific brief document given the gid acquired from previous response

Note

This API requires you to have a access token that should be obtained following Authorization Section. If not obtained please follow the Authorization section to correctly obtain one.

Warning

It is compulsory to have prefix Bearer on Authorization header.

Request

URL : /brief/<brief_slug>/<gid>

Method : GET

Example

curl --location 'https://platform-test.ranenetwork.com/public-api/v1/brief/<brief_slug>/<gid>' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer <access_token> '

Request Formatter

  • access_token : The token achieved using Access Token request

  • brief_slug : Specific brief slug of your interest

  • gid : Specific brief document of your interest

Response

{
  "data": {
    "name": "Cyber Weekly Brief",
    "slug": "cyber-weekly-brief",
    "gid": "8-xxxx",
    "date_option": {
      "picker": [
        {
          "date": "2023-05-30",
          "gid": "8-xxxx"
        },
        {
          "date": "2023-05-31",
          "gid": "8-xxxx"
        }
      ],
      "slider": [
        {
          "date": "May 01",
          "gid": "8-xxxx"
        },
        {
          "date": "May 03",
          "gid": "8-xxxx"
        }
      ]
    },
    "article": [
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          },
          {
            "name": "The Guardian 2",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": true,
        "bookmarked": true,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      },
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          },
          {
            "name": "CNN",
            "link": "https://example.com"
          },
          {
            "name": "BBC",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": false,
        "bookmarked": false,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      },
      {
        "category": "Cyber SecurityThreats + Breaches",
        "title": "Cyber Weekly",
        "source": [
          {
            "name": "The Guardian",
            "link": "https://example.com"
          }
        ],
        "snippet": "This could html tags on them. Example <bold>This should be bold.</bold>",
        "liked": null,
        "bookmarked": false,
        "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A"
      }
    ],
    "bookmarked": true,
    "share": "mailto:?subject=RANE%20Brief%3A%20California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders&body=California%20Case%20Could%20Deal%20Blow%20to%20High-Interest%20Online%20Lenders%0A%0A%3Cp%3EA%20California%20judge%20is%20poised%20to%20decide%20if%20an%20online%20lender%20offering%20small%20loans%20at%20over%20150%25%20interest%20violates%20state%20law%2C%20which%20would%20deal%20a%20blow%20to%20finance%20companies%20that%20critics%20argue%20have%20skirted%20rate%20caps%20to%20profit%20from%20cash-strapped%20borrowers.%20The%20California%20Department%20o%E2%80%A6%0A%0Ahttps%3A%2F%2Fwww.reuters.com%2Fbusiness%2Ffinance%2Fcalifornia-case-could-deal-blow-high-interest-online-lenders-2023-08-31%2F%0A%0A",
    "upgrade": "https://example.com",
    "web": "https://example.com"
  },
  "error": []
}

Response Formatter

  • bookmarked : A boolean value indicating whether or not user has bookmarked certain brief/article.

  • source : An object containing name of website and original link to which article was published

  • share : A mailto link that pushes snippet to mail

  • category : Represent category to which article was labeled for specific brief

  • article : A list of object containing all the articles that were recently published on specific brief

  • date_picker : An object containing all the date where specific brief was published along with document gid

  • data : An object of brief containing publication details and articles of latest brief