SaaS APIs

Introduction to SaaS APIs and Endpoints

Introduction to SaaS APIs

Some Examples of What You Can Do with SaaS APIs

• To tie diverse programs into your user experience, leverage APIs and microservices. You may incorporate functionality from a range of third parties instead of trying to give all conceivable functionality in a single interface.

• Update all of your Google Adwords campaigns at once.

• Take a look at your Shopify orders.

• Create a dashboard for leads using Salesforce and Pardot data.

• Simplify the process of digital transformation.

• Allow headless solutions for mobile apps, corporate apps, app marketplaces, and other applications.

• By offering existing information to customers across a range of media, you may enable omnichannel marketing.

• By connecting third companies via API, you may improve total data visibility.

• Make it easy to spot flaws in a single module without affecting the overall performance of a bigger program.

• Assist consumers in using their KPI dashboard to track data.

• Reduce the number of people that leave your company.

• Allow for the possibility of whitelabeling.

• Using APIs and microservices to improve user experience allows you to create more tailored experiences for your consumers.

• Increase the number of enterprise clients you have.

10 Examples of Popular SaaS Platforms with APIs

What is a REST API?

Other Types of APIs and Their Differences to REST APIs

• GraphQL - GraphQL is a runtime for satisfying queries with existing data, as well as an open-source data query and manipulation language for APIs. GraphQL, which is mostly managed and developed by the GraphQL Foundation, has a wide range of verticals and use cases with many companies embracing it. The fundamental difference between GraphQL and REST APIs is that GraphQL is a query language standard, whereas REST is a network-based computing architectural approach. Note that this article mostly focuses on server-side concerns. As an alternative for REST APIs, GraphQL is gaining traction.

• SOAP API** - A well-known web API protocol is SOAP (simple object access protocol). It's designed to be flexible, agnostic (able to work with a variety of communication protocols, including HTTP, SMTP, TCP, and others), and self-contained (it allows for any programming style) There are a few distinct models in the SOAP specification. How to process a SOAP message is covered by the processing model. SOAP features and modules are used in the extensibility model. How to utilize SOAP with an underlying protocol, such as HTTP, is covered by the protocol binding rules. How to structure a SOAP message is covered in the message construct. Although the two are commonly regarded as rival standards, it is feasible to construct a RESTful API while using SOAP protocols.

• JSON-RPC and XML-RPC- An RPC is a protocol for making a remote procedure call. XML-RPC calls are encoded using XML, whereas JSON-RPC calls are encoded with JSON. Both protocols are straightforward. A call can have numerous arguments, but only one result is expected. They have a few essential characteristics that necessitate a different design than REST. They're made for calling methods, whereas REST protocols are for transferring content (resource representations). REST is concerned with resources, whereas RPC is concerned with actions. The URI identifies the server but has no information in its arguments, whereas the URI in REST contains information like query parameters.

Types of HTTP Methods with a RESTful API

POST

GET

PUT

DELETE

Top 6 SaaS APIs

Zendesk API

Quick Tips on the ZenDesk API

• Zendesk utilizes REST apis

• Accepts encoded request bodies

• Returns responses in JSON (aka JavaScript Object Notation)

• Utilizes standard HTTP response codes and authentication

• You can create (POST), retrieve (GET), update(PUT) and delete (DELETE) Zendesk objects

• Zendesk endpoint URLs will have a server / subdomain that is specific to your account - you set this up when you create an account with Zendesk. So you’ll need to included your specific subdomain in the endpoint URL.
• Eg to get your agent info you use https://{subdomain}.zendesk.com/agent
• So if you work at Acme and created the subdomain acme when you created your account the endpoint you would use is Eg to get your agnent info you use https://acme.zendesk.com/agent

Popular Zendesk API Endpoints

/api/v2/tickets.json

• The full endpoint used is https://{server}.zendesk.com/api/v2/tickets.json

• This endpoint returns all your active Zendesk tickets (archived tickets are excluded)

• The API uses OAuth and applies access permissions such that only tickets the user has access to are returned

• server - refers to your accounts specific subdomain

• Access the official API docs in order to reference what is specifically possible, limitations, how to paginate, etc.

Status 200 OK

{
  "tickets": [
    {
      "assignee_id": 235323,
      "collaborator_ids": [
        35334,
        234
      ],
      "created_at": "2009-07-20T22:55:29Z",
      "custom_fields": [
        {
          "id": 27642,
          "value": "745"
        },
        {
          "id": 27648,
          "value": "yes"
        }
      ],
      "description": "The fire is very colorful.",
      "due_at": null,
      "external_id": "ahg35h3jh",
      "follower_ids": [
        35334,
        234
      ],
      "group_id": 98738,
      "has_incidents": false,
      "id": 35436,
      "organization_id": 509974,
      "priority": "high",
      "problem_id": 9873764,
      "raw_subject": "{{dc.printer_on_fire}}",
      "recipient": "support@company.com",
      "requester_id": 20978392,
      "satisfaction_rating": {
        "comment": "Great support!",
        "id": 1234,
        "score": "good"
      },
      "sharing_agreement_ids": [
        84432
      ],
      "status": "open",
      "subject": "Help, my printer is on fire!",
      "submitter_id": 76872,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "type": "incident",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/tickets/35436.json",
      "via": {
        "channel": "web"
      }
    }
  ]
}

/api/v2/ticket_metrics.json

• This API delivers a list of tickets along with stats for each of them.

• Tickets are sorted by the date they were produced, from newest to oldest.

• Due to ticket archiving, the latest ticket mentioned may not be the absolute oldest ticket in your account.

• The answer does not contain any tickets that have been archived.

• Cursor and Offset pagination are two types of pagination.

• The maximum number of records per page is 100.

• Returns a single measure or all of the metrics for a single ticket.

/api/v2/search.json

• A URL parameter named [query] is used to express search queries.

• The search string query syntax provides a lot of versatility.

• Use [query=123456] for ticket IDs, [query=Johnathan] for any record containing the term Johnathan, [query=type:user "Johnathan James"] for user records that include the specific label "Johnathan James," and so on.

• The equality operator is represented by the ":" letter. "" and ">," the negative sign, and the wildcard character "*" are among the other operators.

• A search query is specified using double quotations, "". Exact word matches are used by the API.

/api/v2/users.json

• You may use this API to get a list of Zendesk users.

• Although cursor pagination is preferred, offset pagination is also an option.

• The maximum number of records per page is 100.

• Admins, Agents, and Light Agents are permitted to use this endpoint.

• Using "external id," you may get a list of people based on their external id. Each user under the same account must have a unique external id.

• For custom roles, use "permission set," which is accessible on the Enterprise plan and higher. Per request, you may only filter by one role ID.

Rentman API

Quick Tips on the Rentman API

• Try using this API to save files into offline storage.

• Use this API to send out feedback forms.

• Try connecting this API to your existing HR software.

Popular Rentman API Endpoints

appointmentcrew

• You may use this endpoint to find out which crew member is associated with a certain appointment.

• You can also use this endpoint to create appointmentcrew linked items and get appointmentcrew linked collections.

• [Array of objects] = All of the information about the items requested.

• [limit#] = The maximum number of elements in data that can be stored.

• [offset#] = The number of elements in the data that were skipped.

appointments

• You may read, write, edit, and remove appointments in Rentman using this endpoint.

• Obtain an appointments collection, get an appointments item, update appointments items, and remove appointments things.

contactpersons

• Within a Contact, this endpoint indicates a person or department.

• A single Contact is always connected with a Person item.

• This may be used to obtain information on a contactperson's collection, item, and so on.

• This endpoint may also be used to edit a single item, remove a user's entry, or get files as a linked collection.

contacts

• This endpoint represents a business or an individual.

• This API may be used to create new contacts, retrieve contact collections, extract a contact or item listed under a contact, and edit or remove contacts.

Pipedrive API

### Quick Tips on the Pipedrive API

• Use [https://status.pipedrive.com/] to monitor the status of Pipedrive API.

• Remember that you will need to validate apps through the OAuth 2.0 flow.

• Keep your API token in a safe place.

Popular Pipedrive API Endpoints

/v1/deals

• Deals are sales to an organization or a person that are ongoing, lost, or won.

• Each transaction has a monetary value and must be assigned to one of many stages.

• A user can own a deal, and one or more people can follow it.

• This API retrieves all deals based on user ID, filter ID, stag ID, status, limit, sort, and other criteria.

/v1/organizations

• Companies and other types of organizations with whom you do business are referred to as organizations.

• Organizations can be related with people, and each organization can have one or more people.

• All organizations are returned by this endpoint.

• User and filter IDs, as well as start, limit, and sort, are some of the options.

/v1/users

• People who have access to your Pipedrive account are known as users.

• A user can be associated with one or more Pipedrive accounts, therefore removing a user from one account will not remove them from the data storage if they have numerous accounts.

• This endpoint gives information about all corporate users.

• Allows you to search for users by name, followers, and other criteria.

/v1/activities

• Activities in a calendar are appointments, tasks, or events that can be linked to a deal, a lead, a person, or an organization.

• Activities can be of many types and allocated to certain users.

• This service gives a list of all actions associated with a certain user.

• Filter ID, type, limit, start, start date, end date, done, and other parameters are available.

Trello API

Quick Tips on the Trello API

• Remember that this API can be used for notifications and tokens, not just checklists and boards.

• Trello uses a delegated authentication flow for added security.

• Try to keep the bulk of your focus on Boards, but be sure to branch out into different features to really get the most out of this API.

Popular Trello API Endpoints

• /1/boards/{boardId}

• /boardStars, /1/actions/{id}

• /1/checklists/{id}/{field}

• /1/lists/{id}/moveAllCards.

• Trello API’s base endpoint is https://api.trello.com/

/1/boards/{boardId}/boardStars

• Users can get boardStars on a Board using this endpoint.

• Application/json is the content type.

• Make use of the GET command.

• "Mine" and "none" are examples of valid values.

/1/actions/{id}

• This endpoint allows users to get an action with the “Get” feature.

• Should include the ID of the action.

• Query parameters include display, entities, fields, members, etc.

/1/checklists/{id}/{field}

• This endpoint makes it possible to get a field on a Checklist.

• Path parameters include string ID and string field.

/1/lists/{id}/moveAllCards

• This endpoint allows users to move all of the cards in a particular list.

• Path parameters include string ID.

• Query parameters include idBoard, idList, etc.

Mailchimp API

Quick Tips on the Mailchimp API

• Remember that administrators can see and generate API keys for other users.

• Disable your API keys if you believe your Mailchimp account has been compromised.

• Use API Root to view all available resources in the API.

Popular Mailchimp API Endpoints

/3.0/reports

• [reports] refers to a variety of objects, each representing a specific report resource.

• This endpoint uses the Get features to generate campaign reports.

• Query parameters include fields, exclude_fields, count, offset, type, before_send_time, since_said_time, etc.

/3.0/lists/{list_id}/members

• This allows users to list members’ information and get information about members in a very specific list in Mailchimp.

• Path parameters include list_ID.

• Query parameters include fields, count, offset, email_type, and more.

/3.0/campaigns

• Campaigns are the means via which you deliver emails to your Mailchimp subscribers.

• To manage campaigns in your Mailchimp account, use the Campaigns API methods.

• This endpoint allows you to retrieve all of the campaigns in a given account.

• Fields, count, offset, type, status, list ID, sort dir, and other parameters are among the query parameters.

/3.0/lists/{list_id}/growth-history

• The ability to read a summary of a list's month-by-month growth activities is referred to as growth history.

• Users may get list growth history data and a month-by-month overview of a single list's growth activities using this endpoint.

Harvest App API

Quick Tips on the Harvest App API

• We recommend using the V2 version instead of the legacy V1 documentation.

• API requests include GET, POST, PATCH, and DELETE.

• API responses are formatted in JSON and HTTP is used for response codes.

Popular Harvest App API Endpoints

• /v2/reports/project_budget

• /v2/reports/uninvoiced

• /v2/reports/time/clients

• /v2/contacts

• Harvest App API’s base endpoint is https://api.harvestapp.com

/v2/reports/project_budget

• Users can view a project's budget report for a certain timeframe using this API.

• An object having a "results" property in the response includes an array of up to "per page" results. Each element of the array represents a distinct result object.

/v2/reports/uninvoiced

• The Uninvoiced Report allows administrators to see all projects.

• Managers who have the ability to produce invoices can only see projects that they are responsible for.

• Users can view all uninvoiced reports using this endpoint.

/v2/reports/time/clients

• Where recorded time is present for a particular timeframe, time reports display the hours and billable information for each client, project, task, or user.

• Each time a report is requested, the URL's query string must include both the "from" and "to" parameters.

/v2/contacts

• A list of your contacts is returned by this endpoint.

• The contacts are returned in the order in which they were generated, with the most recently formed contacts showing first.