Locate IDs

We have outlined the best ways to locate the Id you’re looking for:

If you have any questions, don’t hesitate to contact us at support@scribblelive.com.

…………………………………………………………………………………………………………………..

Article Id

ARTICLE

To locate the Article Id:

Manually:

  • Open your article on the back-end
  • Copy the Article Id from the end of the url

Through Code- via Client Id:

  • Get your Client Id
  • HTTP Request to apiv1.scribblelive.com/client/{client-id}/articles/list
  • Parse JSON Response > ELEMENT.Article.Id = Article Id

Through Code – via Website Id:

  • Get your Website/Whitelablel Id
  • HTTP Request to apiv1.scribblelive.com/website/{Website Id}/articles
  • Parse JSON Response > Articles.[n].Id = Article Id

LIVE ARTICLE

To locate the Live Article Id:

  • Get your Event Id
  • HTTP Request to apiv1.scribblelive.com/event/{event-id}
  • Parse JSON Response > Live Article : {LiveArticle-id}

…………………………………………………………………………………………………………………..

Client Id

To locate your Client Id:

  • Go to Settings > API > Clients
  • The id is pre-filled in the client related API calls
  • e.g.: Expand GET/client/{client id} to see the sandbox. The Client Id field will be pre-filled

…………………………………………………………………………………………………………………..

Comment Id

You will need the Post Id in order to retrieve the Comment Id.

  • Retrieve the Post Ids of the posts you want to get the comments for
  • HTTP Request to apiv1.scribblelive.com/post/discussion?PostsIds={post-id},{post-id}…
  • Parse JSON Response > entries[n].OpId = Comment Id

…………………………………………………………………………………………………………………..

Event Id

To locate the Event Id:

Manually:

  • Open your event**
  • Copy the Event Id from the end of the URL
**Note:

If using the Content Studio, the Event Id will be found at the end of the url.

If you  are using Original Writer’s Interface,go to Menu > Setup > Stream. The Event Id will be at the end of the url.

Through Code- via Client Id:

  • Get your Client Id
  • HTTP Request to apiv1.scribblelive.com/client/{client-id}/events
  • Parse JSON Response > Events[n].Id = Events Id

Through Code – via Website Id:

  • Get your Website/Whitelablel Id
  • HTTP Request to apiv1.scribblelive.com/website/{Website Id}/events
  • Parse JSON Response > Events[n].Id = Events Id

…………………………………………………………………………………………………………………..

Poll Id

To locate the Poll Id:

  • Retrieve the post that is linked to the poll (A poll is a type of post)
  • Parse JSON > POST.Entities.id = Poll Id

…………………………………………………………………………………………………………………..

Post Id

To locate the Post Id:

Manually:

  • Go to the post on the back-end
  • Locate the permalink for the post (by clicking the options menu)
  • The numerical value at the end of the permalink is the Post Id

Through Code via Event Id:

  • Retrieve posts via GET/event/{event-id}/page/{page-number} or /event/{Event Id}/all or equivalent HTTP requests that return a list of posts.
  • HTTP Request to apiv1.scribblelive.com/event/{event-id}/page/{page-number}
  • Parse JSON Response > Posts[n].Id = Post ID

…………………………………………………………………………………………………………………..

User Id

Back-end users with the sufficient permission level are able to interact with the stream via the API. To locate the User Id for a back-end user:

  • Base64 encode your username (email) and password
  • Perform a basic auth to apiv1.scribblelive.com/user

…………………………………………………………………………………………………………………..

Website Id

In cases where it is necessary to retrieve all events from your whitelabel, you will need your site’s website ID.

To locate your Website Id:

Manually:

  • Go to the Mange Templates page by clicking Manage > Templates on the left sidebar (Alternatively, from within your stream, go to Menu> Setup > Templates)
  • Select the Whitelabel tab at the top of the page, and click a whitelabel template from the list.
  • Click the Edit button. The website ID is located at the end of the template generated URL in your browser address bar

Note: Only users with Administrator and Developer roles will be able to edit a template and locate the Website Id.

Through Code- via Client Id:

  • Get your Client Id
  • HTTP Request to apiv1.scribblelive.com/client/{client-id}/websites/list
  • Parse JSON Response > Websites[n].Id = Website Id
Advertisements