Please enable JavaScript.

Coggle requires JavaScript to display documents.

REST API (Resources (Endpoint (The URL for a resource, For a given…

- - - - Popular authorization platform
      - open protocol
      - Benefit for users with different previleges
      - Ways to handle authorization
        
        One-legged
        
        Used when no sensitive user data, such as weather forecast api
        
        Three-legged
        
        Used to protect user data
        
        Have a authentication server than one-legged
      - Grant types
        
        Authorization code: used with server-side applications
        
        Implicit: Used with mobile apps and web browsers
    - - Tokens are temporary
      - Most commonly put in the header
    - - How to use the token
        
        Include token information in the appropriate table.
        
        Header or query parameter
      - Authorization
        
        Detailed steps on how to get an access token
        
        How to get access token from the server's redirect URL
        
        URL of the authentication server
        
        How to pass the token to server
        
        Token often expires after a fixed amount of time. Describe how to get a new token if this happens.
  - - - Can affect revenue
      - Limit access
      - Collect important data on how API is used
      - User info should be private
- - - - Standard HTTP methods (CRUD)
        
        Retrieve: GET
        
        No body
        
        Retrieves data
        
        Use IDs in the URL to specify a particular object
        
        Create: POST
        
        Create a new resource object
        
        Data for creating object is in the body
        
        Update: PUT
        
        Modify an existing resource object
        
        Data for updating the object is in body
        
        Use IDs in the URL to specify which object to modify
        
        Delete: DELETE
        
        Delete an object
        
        No body
        
        Use IDs in the URL to specify which object to be deleted
      - The action you take
      - Not all requests fits CRUD model
    - - Example: http://api.example.com/users
      - Uniform resource locator
      - Start with http or https; followed by server info; then the resource info
      - Same thing as you put into address bar in brower
    - - Example (in bold): http://api.example.com/users?**source=ios&device=ipad**
      - Modify or filter the data returned
      - key/value pairs
        
        key and value are separated by equals sign
        
        key/value pairs are separated by "&"
      - Contained additional data you can send to the server
      - After question marks in the URL
      - Used for authorization
        
        such as token, apikey
      - Documentation
        
        Parameter name
        
        Description
        
        Type
        
        Technically all are strings
        
        Required
        
        Notes
        
        If the values are limited to a set, put that in a note
    - - Used for specific type of data
      - Standard headers for HTTP requests
      - Commonly used for data formats and security
        
        Data format
        
        Data format you send
        
        key: Content-Type
        value: application/json (for JSON); application/xml (for XML); image/jpeg (for image)
        
        Only POST and PUT
        
        Data format you receive in response
        
        key: Accept
        value: application/json (for JSON); application/xml (for XML); image/jpeg (for image)
        
        Complex format of the resource
        
        Security
        
        Authentication token: Bearer header
      - key/value pairs
      - Documentation
        
        Header name
        
        Description
        
        Values
    - - Example:
        {
        "name": "Peter Gruenbaum"
        "email": "peter@sdkbridge.com"
        }
      - Sending a significant amount of data to the server
      - Can be any format; usually JSON or XML; can also be media files (image, video, sound files)
      - Only have a body for POST and PUT
      - To create or modify data in the server
      - Documentation
        
        Structured data
        
        Element
        
        Type
        
        Description
        
        Notes
        
        Required (Request only)
        
        URL in response
        
        If the response returns a huge amount of data, return limited data using URL links to more data
        
        No response
        
        Just say: no response body is returned
        
        Object section
        
        API requests return the same type of data, so the response info and sample responses are redundant
        
        Create an Object section of the docs which contain responses body
        
        Link to the Object section from the request section
        
        Errors
        
        HTTP status code
        
        Part of HTTP protocol
        
        A status code is always returned with the response
        
        Have a code and description
        
        Documentation: A table with code, description, note
        
        Errors in response body
        
        Document like other response elements