voesxapi

README

VOESXAPI

A golang package to easily interact with the voe's api. For general api doc I recommend their documentation as it's pretty well crafted.

Getting started

package main

import(
    "fmt"
)

const VOE_API_KEY = "..." // or in config.go

func main() {
    fmt.Println("WIP")
}

For more info go read the source code of the lib, it is pretty simple and self explanatory.

NOTE: Yes I now my functions and variables are snake case, so what ? - Do not use this library if you feel intimidated by primal notation (big L to go lang's way of exporting function)

Documentation

Index

• Constants
• func Rate_limit()
• type VoeGetNextServ
  • func Get_next_server(api_key string) (VoeGetNextServ, error)
• type VoePostUpload
  • func Post_upload(api_key string, upload_url string, file_path string) (VoePostUpload, error)

Constants

const REQUEST_DELAY = 1 // true value = 1/3 req per sec

Rate limit: 9 requests / 3 seconds

Functions

func Rate_limit

func Rate_limit()

Types

type VoeGetNextServ

type VoeGetNextServ struct {
	ServerTime string `json:"server_time"`
	Msg        string `json:"msg"`
	Message    string `json:"message"`
	Status     int    `json:"status"`
	Success    bool   `json:"success"`
	Result     string `json:"result"`
}

func Get_next_server

func Get_next_server(api_key string) (VoeGetNextServ, error)

type VoePostUpload

type VoePostUpload struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	File    struct {
		ID                int    `json:"id"`
		FileCode          string `json:"file_code"`
		FileTitle         string `json:"file_title"`
		EncodingNecessary bool   `json:"encoding_necessary"`
	} `json:"file"`
}

func Post_upload

func Post_upload(api_key string, upload_url string, file_path string) (VoePostUpload, error)