Metadata-Version: 1.0
Name: vericred_client
Version: 0.0.3
Summary: Vericred API
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Description:     Vericred&#39;s API allows you to search for Health Plans that a specific doctor
        accepts.
        
        ## Getting Started
        
        Visit our [Developer Portal](https://vericred.3scale.net) to
        create an account.
        
        Once you have created an account, you can create one Application for
        Production and another for our Sandbox (select the appropriate Plan when
        you create the Application).
        
        ## Authentication
        
        To authenticate, pass the API Key you created in the Developer Portal as
        a &#x60;Vericred-Api-Key&#x60; header.
        
        &#x60;curl -H &#39;Vericred-Api-Key: YOUR_KEY&#39; &quot;https://api.vericred.com/providers?search_term&#x3D;Foo&amp;zip_code&#x3D;11215&quot;&#x60;
        
        ## Versioning
        
        Vericred&#39;s API default to the latest version.  However, if you need a specific
        version, you can request it with an &#x60;Accept-Version&#x60; header.
        
        The current version is &#x60;v3&#x60;.  Previous versions are &#x60;v1&#x60; and &#x60;v2&#x60;.
        
        &#x60;curl -H &#39;Vericred-Api-Key: YOUR_KEY&#39; -H &#39;Accept-Version: v2&#39; &quot;https://api.vericred.com/providers?search_term&#x3D;Foo&amp;zip_code&#x3D;11215&quot;&#x60;
        
        ## Pagination
        
        Most endpoints are not paginated.  It will be noted in the documentation if/when
        an endpoint is paginated.
        
        When pagination is present, a &#x60;meta&#x60; stanza will be present in the response
        with the total number of records
        
        &#x60;&#x60;&#x60;
        {
          things: [{ id: 1 }, { id: 2 }],
          meta: { total: 500 }
        }
        &#x60;&#x60;&#x60;
        
        ## Sideloading
        
        When we return multiple levels of an object graph (e.g. &#x60;Provider&#x60;s and their &#x60;State&#x60;s
        we sideload the associated data.  In this example, we would provide an Array of
        &#x60;State&#x60;s and a &#x60;state_id&#x60; for each provider.  This is done primarily to reduce the
        payload size since many of the &#x60;Provider&#x60;s will share a &#x60;State&#x60;
        
        &#x60;&#x60;&#x60;
        {
          providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
          states: [{ id: 1, code: &#39;NY&#39; }]
        }
        &#x60;&#x60;&#x60;
        
        If you need the second level of the object graph, you can just match the
        corresponding id.
        
        ## Selecting specific data
        
        All endpoints allow you to specify which fields you would like to return.
        This allows you to limit the response to contain only the data you need.
        
        For example, let&#39;s take a request that returns the following JSON by default
        
        &#x60;&#x60;&#x60;
        {
          provider: {
            id: 1,
            name: &#39;John&#39;,
            phone: &#39;1234567890&#39;,
            field_we_dont_care_about: &#39;value_we_dont_care_about&#39;
          },
          states: [{
            id: 1,
            name: &#39;New York&#39;,
            code: &#39;NY&#39;,
            field_we_dont_care_about: &#39;value_we_dont_care_about&#39;
          }]
        }
        &#x60;&#x60;&#x60;
        
        To limit our results to only return the fields we care about, we specify the
        &#x60;select&#x60; query string parameter for the corresponding fields in the JSON
        document.
        
        In this case, we want to select &#x60;name&#x60; and &#x60;phone&#x60; from the &#x60;provider&#x60; key,
        so we would add the parameters &#x60;select&#x3D;provider.name,provider.phone&#x60;.
        We also want the &#x60;name&#x60; and &#x60;code&#x60; from the &#x60;states&#x60; key, so we would
        add the parameters &#x60;select&#x3D;states.name,staes.code&#x60;.  The id field of
        each document is always returned whether or not it is requested.
        
        Our final request would be &#x60;GET /providers/12345?select&#x3D;provider.name,provider.phone,states.name,states.code&#x60;
        
        The response would be
        
        &#x60;&#x60;&#x60;
        {
          provider: {
            id: 1,
            name: &#39;John&#39;,
            phone: &#39;1234567890&#39;
          },
          states: [{
            id: 1,
            name: &#39;New York&#39;,
            code: &#39;NY&#39;
          }]
        }
        &#x60;&#x60;&#x60;
        
        
            
Keywords: Swagger,Vericred API
Platform: UNKNOWN
