Doctofam Clinics API

openapi: 3.2.0
info:
  title: Doctofam Clinics API
  version: 1.0.0
  description: 'Public REST API for Doctofam. Authenticate with an API key created in the Doctofam dashboard: send the base64-encoded key secret with HTTP Basic auth. Each key carries per-resource scopes like `patients:read` or `appointments:write`.'
servers:
- url: https://api.doctofam.com
tags:
- name: Clinics
paths:
  /api/clinics:
    get:
      tags:
      - Clinics
      summary: List clinics
      description: Lists the clinics of your organization. Requires the `clinics:read` scope.
      security:
      - apiKey: []
      - accessToken: []
      responses:
        '200':
          description: Array of clinics
        '401':
          description: Missing or invalid credentials
        '403':
          description: API key is missing the `clinics:read` scope
        '429':
          description: API key rate limit exceeded
      operationId: getApiClinics
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.doctofam.com/api/clinics',\n  headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'}\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.doctofam.com/api/clinics \\\n  --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
      - lang: Shell + Httpie
        source: "http GET https://api.doctofam.com/api/clinics \\\n  Authorization:'Basic REPLACE_BASIC_AUTH'"
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.doctofam.com")


          headers = { ''Authorization'': "Basic REPLACE_BASIC_AUTH" }


          conn.request("GET", "/api/clinics", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.doctofam.com/api/clinics\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: Basic REPLACE_BASIC_AUTH\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.doctofam.com/api/clinics');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.doctofam.com/api/clinics');\n$request->setRequestMethod('GET');\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
  /api/clinics/{clinicId}:
    get:
      tags:
      - Clinics
      summary: Get a clinic by id
      description: 'Returns a single clinic. Credentials are optional: the clinic''s public website already serves every field, so an anonymous caller gets the same record. An authenticated caller needs the `clinics:read` scope and gets 404 for a clinic in another organization so ids cannot be probed.'
      security:
      - apiKey: []
      - accessToken: []
      parameters:
      - in: path
        name: clinicId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The clinic
        '403':
          description: API key is missing the `clinics:read` scope
        '404':
          description: No such clinic in your organization
      operationId: getApiClinicsClinicId
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.doctofam.com/api/clinics/%7BclinicId%7D',\n  headers: {Authorization: 'Basic REPLACE_BASIC_AUTH'}\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request GET \\\n  --url https://api.doctofam.com/api/clinics/%7BclinicId%7D \\\n  --header 'Authorization: Basic REPLACE_BASIC_AUTH'"
      - lang: Shell + Httpie
        source: "http GET https://api.doctofam.com/api/clinics/%7BclinicId%7D \\\n  Authorization:'Basic REPLACE_BASIC_AUTH'"
      - lang: Python + Python3
        source: 'import http.client


          conn = http.client.HTTPSConnection("api.doctofam.com")


          headers = { ''Authorization'': "Basic REPLACE_BASIC_AUTH" }


          conn.request("GET", "/api/clinics/%7BclinicId%7D", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.doctofam.com/api/clinics/%7BclinicId%7D\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: Basic REPLACE_BASIC_AUTH\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.doctofam.com/api/clinics/%7BclinicId%7D');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$request->setRequestUrl('https://api.doctofam.com/api/clinics/%7BclinicId%7D');\n$request->setRequestMethod('GET');\n$request->setHeaders([\n  'Authorization' => 'Basic REPLACE_BASIC_AUTH'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: 'HTTP Basic auth carrying only the API key secret: `Authorization: Basic base64(<key secret>)`.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Operator session token issued by the Doctofam dashboard: `Authorization: Token <access token>`.'