k-kaufmann/chefkoch-api

Basic client to read data from chefkoch.de

0.3.1 2021-03-20 15:16 UTC

Requires

• ext-json: *
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• kkaufmann

README

PHP library to access API data from chefkoch.de

Get started

<?php
use chefkoch\ChefkochFactory;

$chefkochFactory = new ChefkochFactory();
$apiClient = $chefkochFactory->createApiClient();

$user = $apiClient->getUserById("INPUT_USER_ID");
$simpleRecipes = $apiClient->getRecipes("OFFSET");
$categories = $apiClient->getCateogries();
$recipe = $apiClient->getRecipeById("RECIPE_ID");

Data

Accessible data from the API

User

• id type: string
• username type: string
• rank type: integer
• hasAvatar type: boolean
• hasPaid type: boolean
• deleted type: boolean

SimpleRecipe (for requests to get a list of recipes)

• id type: string
• type type: int
• title type: string
• subtitle type: string
• owner type: array
• rating type: array
• difficulty type: int
• hasImage type: bool
• hasVideo type: bool
• previewImageId type: ?string
• preparationTime type: int
• isSubmitted type: bool
• isRejected type: bool
• imageCount type: int
• createdAt type: DateTime
• editor type ?string
• submissionDate type: ?DateTime
• isPremium type: bool
• status type: int
• siteUrl type: string

Recipe

• id type: string
• type type: int
• title type: string
• subtitle type: string
• owner type: array
• rating type: array
• difficulty type: int
• hasImage type: bool
• hasVideo type: bool
• previewImageId type: string
• preparationTime type: int
• isSubmitted type: bool
• isRejected type: bool
• createdAt type: DateTime
• imageCount type: int
• editor type: ?array
• submissionDate type: ?DateTime
• isPremium type: bool
• status type: int
• servings type: int
• kCalories type: int
• instruction type: string
• miscellaneousText type: string
• ingredientsText type: string
• tags type: array
• fullTags type: array
• viewCount type: int
• cookingTime type: int
• restingTime type: int
• totalTime type: int
• ingredientsGroups type: array
• categoryIds type: array
• recipeVideoId type: string
• isIndexable type: bool
• siteUrl type: string

Category

• id type: string,
• title type: string,
• parentId type: ?string,
• level type: int,
• descriptionText, type: string,
• linkName, type: string