Getting started

To connect with the Overclay-Api and use it's benifits you have to register for an API-Key. We will verify if you are in the correct requirements to use Overclay on your Services

If you have your API-Key you can use the Overclay API. This documentation will guide you through the process of connecting your service with Overclay and make requests to your clients.

Connect your Service

Requirements

To connect your Service to the Overclay API you have to own an Overclay-API-Key. An rest-Server or any sort of http-Connector is required to send your requests.

Send Online Status

In the next step, you have to tell overclay that your Service is online.

Send a POST-Request to this address: https://api.overclay.net/service/status/

Send this Body and replace "YOUR_API_KEY" with your API-Key.

        
            {
                "api_key": "YOUR_API_KEY",
                "status": "online"
            }
        
        

You can send the following status:

  • online - to mark your service as usable
  • offline - to mark your service as unreachable
  • maintenance - to mark your service as unusable for a short period
  • On registration of your service the status is set to offline.

    Use the Response

    After sending the request you will get a response from the Overclay API. The Status-Code of the Response will tell you if your request was sucessful.

  • 200 - the status was sucessfully set
  • 400 - the request was invalid
  • 401 - the API-Key is invalid
  • 500 - the server encountered an error
  • Send data to the Client

    Requirements

    To send data to the Client the User must have a Connection to your Service astablished.

    Send Data

    Send a POST-Request to this address: https://api.overclay.net/user/data/

    Send this Body and replace "YOUR_API_KEY" with your API-Key and "USERNAME" with the User. Replace "YOUR_COMMAND" with one of the following commands out of the pool. Just make sure to use correct Syntax.

            
                {
                    "api_key": "YOUR_API_KEY",
                    "username": "USERNAME",
                    "command": "YOUR_COMMAND"
                }
            
            

    After sending the Request you get a Response with a Status-Code:

  • 200 - the command was sucessfully sent
  • 400 - the request was invalid
  • 401 - the API-Key is invalid
  • 404 - the User is not connected to your Service
  • 500 - the server encountered an error
  • Commands

    Send Notification

    Send a Message to the User. Replace "YOUR_MESSAGE" with the Message you want to send.

            
                {
                    "command": "notification",
                    "message" YOUR_MESSAGE"
                }
            
            

    If you want to send a Notification with an Icon you can add the Icon-Property:

                
                    {
                        "command": "notification",
                        "message" YOUR_MESSAGE",
                        "icon": "YOUR_ICON"
                    }
                
            

    Replace your Icon with an Icon from this List:

    • home
    • sign-in
    • sign-out
    • user
    • users
    • lock
    • unlock
    • settings
    • cog
    • nut
    • comment
    • commenting
    • comments
    • hashtag
    • tag
    • cart
    • bag
    • credit-card
    • mail
    • receiver
    • print
    • search
    • location
    • bookmark
    • code
    • paint-bucket
    • camera
    • video-camera
    • bell
    • microphone
    • bolt
    • star
    • heart
    • happy
    • lifesaver
    • rss
    • social
    • git-branch
    • git-fork
    • world
    • calendar
    • clock
    • history
    • future
    • pencil
    • trash
    • move
    • link
    • question
    • info
    • warning
    • image
    • thumbnails
    • table
    • list
    • menu
    • grid
    • more
    • more-vertical
    • plus
    • plus-circle
    • minus
    • minus-circle
    • close
    • check
    • ban
    • refresh
    • play
    • play-circle
    • file
    • file-text
    • file-pdf
    • copy
    • file-edit
    • folder
    • album
    • push
    • pull
    • server
    • database
    • cloud-upload
    • cloud-download
    • download
    • upload
    • reply
    • forward
    • expand
    • shrink
    • arrow-up
    • arrow-down
    • arrow-left
    • arrow-right
    • chevron-up
    • chevron-down
    • chevron-left
    • chevron-right
    • chevron-double-left
    • chevron-double-right
    • triangle-up
    • triangle-down
    • triangle-left
    • triangle-right
    • 500px
    • behance
    • discord
    • dribbble
    • etsy
    • facebook
    • flickr
    • foursquare
    • github
    • github-alt
    • gitter
    • google
    • instagram
    • joomla
    • linkedin
    • pagekit
    • pinterest
    • reddit
    • soundcloud
    • tiktok
    • tripadvisor
    • tumblr
    • twitch
    • twitter
    • vimeo
    • whatsapp
    • wordpress
    • xing
    • yelp
    • youtube

    If you want to modify the position of the Notification on the Client you can add the Position property.

                
                    {
                        "type": "notification",
                        "message": "This is a notification",
                        "position": "YOUR_POSITION",
                    }
                
            
                

    LATEX

    %PAKETE: \usepackage{amsmath} %mathe \usepackage{amssymb} %mathe zeichen paket \section{Mathematik-Umgebung} Um eine mathematische Formel schön darzustellen, ist \LaTeX perfekt. Will man die Formel in einem Fließtext schreiben so macht man nur Dollarzeichen. Zum Beispiel schreibt man die Gleichung $2x=3$ so in den Fließtext. Will ich die Konstante $e$ schreiben, nehme ich auch Dollarzeichen.\\ Wenn man eine längere Gleichung, wie Extremwertaufgaben $$(2x+3)^2=4x^2+12x+9$$ in eine Extrazeile schreiben möchte, nimmt an um die Formel 2 Dollarzeichen. Brauche ich eine ganze Mathe-Umgebung, benötige ich die Pakete \textit{amsmath} und \textit{amssymb}. Die ganze Rechnung schreibt man dann in \textbf{align}. \begin{align*} %mit dem Sternchen -> keine Nnummerierung mehr! &f(x)=3\cdot x^4-2\cdot x^2+13\\ %\cdot ist der Malpunkt! &f'(x)=12\cdot x^3-4\cdot x \end{align*} Mit einem kaufmännischen und (\&) kann man die Gleichungen schön übereinander stellen. Nun wollen wir noch einen nützlichen Link einfügen, wir brauchen dafür das Paket \textbf{hyperref}. Generell hilfreich bei Latex-Problemen ist der Link: \url{https://de.wikipedia.org/wiki/Hilfe:TeX} sowie der Link \url{https://detexify.kirelabs.org/classify.html}. \begin{align*} A_{Dreieck} = \frac{a\cdot h_a}{2} \\ \end{align*} % _, wenn ich einen Index anhängen möchte. % \frac{}{} bei einem Bruch

    Overclay Client

    © 2022 Hexle Development Systems Impressum