Lets Understand API

API stands for Application Programming Interface. It is defined how two pieces of software talk to eachother.

Types of APIs:

1) Web ( Rest, SOAP)

2) Platform (java, C++ etc)

Web APIs : We write for Software Developer Audience

Re : Representational

S: State

T: Transfer

It is design pattern not a protocol. Format of REST are JASON and XML 

SOAP

• Before REST we had SOAP
• SOAP: Simple Object Access Protocol
• It only supports XML only
• It is a protocol not a design pattern.

C: Create Resource Objets - POST

R: Retrieve Resource Objets- GET

U: Update Resource Objets - PUT

D:elete Resource Objets – DELETE

There are 3 ways that a data format can be specified:

Headers

Query Parameters

Suffix



Anatomy of a REQUEST

POST https://api.example.com/user?resource=device=ipad.

METHOD RESOURCE INFORMATION QUERY PARAM

Accept: application/json HEADER

Content_type:application/json

{

BODY

"name : "John Snow "

"email: snow.jon@doctoolss.com

}

CRUD METHOD

• CREATE - PUT
• RETRIEVE - GET
• UPDATE - PUT
• DELETE - DELETE
• 
  

STATUS CODE

200 - OK

201 - CREATED

401 - UNAUTHORIZED

404 - NOT FOUND

403 - The no of API REQUEST per Month has been EXECUTED

For more information on Technologies/best practices:

Contact DocTooLss |”We make Technology EaZy via Docs”


Follow us @doctools8 | email: task.theme@gmail.com| WordPress: www.doctoolss.wordpress.com | Website: www.doctoolss.com